@robotlegsjs/core

RobotlegsJS

RobotlegsJS is a architecture-based IoC framework for JavaScript/TypeScript. This version is a direct port from the ActionScript 3.0 codebase. See the motivation behind it.

Right now, this framework has extensions for pixi.js v5, easeljs, openfl, phaser-ce v2 and phaser v3.

Features

• Dependency injection (through InversifyJS)

• Command management

• View management

Extensions

• RobotlegsJS-Macrobot: extends commands, adding support to async and macro commands.

• RobotlegsJS-SignalCommandMap: maps SignalsJS to commands.

• RobotlegsJS-EventEmitter3: integrate RobotlegsJS with EventEmitter3.

• RobotlegsJS-Pixi: integrate RobotlegsJS with PixiJS.

• RobotlegsJS-Pixi-Palidor: a view manager extension for RobotlegsJS-Pixi.

• RobotlegsJS-Pixi-SignalMediator: a port of Robotlegs SignalMediator Extension to TypeScript.

• RobotlegsJS-CreateJS: integrate RobotlegsJS with EaselJS.

• RobotlegsJS-OpenFL: integrate RobotlegsJS with OpenFL.

• RobotlegsJS-Phaser-CE: integrate RobotlegsJS with Phaser-CE.

• RobotlegsJS-Phaser-CE-SignalCommandMap: maps Phaser.Signal to commands.

• RobotlegsJS-Phaser: integrate RobotlegsJS with Phaser.

Installation

You can get the latest release and the type definitions using NPM:

npm install @robotlegsjs/core reflect-metadata --save

Or using Yarn:

yarn add @robotlegsjs/core reflect-metadata

:warning: Important! RobotlegsJS requires TypeScript >= 2.0 and the experimentalDecorators, emitDecoratorMetadata, types and lib compilation options in your tsconfig.json file.

{
    "compilerOptions": {
        "target": "es5",
        "lib": ["es6", "dom"],
        "types": ["reflect-metadata"],
        "module": "commonjs",
        "moduleResolution": "node",
        "experimentalDecorators": true,
        "emitDecoratorMetadata": true
    }
}

RobotlegsJS requires a modern JavaScript engine with support for:

• Reflect metadata
• Map

If your environment doesn't support one of these you will need to import a shim or polyfill.

:warning: The reflect-metadata polyfill should be imported only once in your entire application because the Reflect object is meant to be a global singleton. More details about this can be found here.

Check out the Environment support and polyfills page in the InversifyJS wiki and their Basic example to learn more.

To learn more about the basic usage and APIs provided by InversifyJS, follow The Basics and The InversifyJS Features and API.

Motivation

There are many frameworks and patterns out there that helps you to write DOM-based applications. There is no scalable solution yet to architecture a canvas-based application though.

Robotlegs has proven itself of being a mature solution from the ActionScript community for interactive experiences.

RobotlegsJS for enterprise

Available as part of the Tidelift Subscription

The maintainers of @robotlegsjs/core and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

License

MIT